ts-toolbelt
Advanced tools
The ts-toolbelt package provides a comprehensive set of type utilities to improve TypeScript typing and enable type transformations, checks, and more complex operations. It enhances TypeScript's static typing capabilities and helps in building more robust type-safe applications.
Object Manipulation
Merge two types into one. This is useful for combining properties from multiple objects into a single type.
{ type Merged = Merge<{name: string}, {age: number}>; // Result: {name: string, age: number} }Type Checking
Check if two types are equivalent. This utility helps in validating type structures for consistency.
{ type check = Equals<{a: string}, {a: string, b: number}>; // Result: false }Conditional Types
Apply conditional logic to types. This feature allows for conditional type assignments based on certain conditions.
{ type Conditional = If<true, 'Yes', 'No'>; // Result: 'Yes' }Provides a collection of utility types for TypeScript, similar to ts-toolbelt. While utility-types focuses more on transformations and mappings, ts-toolbelt offers a broader range of type operations including type checks and advanced manipulations.
A package that includes a variety of utility types for TypeScript. Type-fest is similar to ts-toolbelt but tends to be simpler and more focused on everyday use cases, whereas ts-toolbelt provides more comprehensive and complex utilities for advanced type manipulation.
📖 Read Docs · 🎮 View Demo · 🐞 Report Bug · 🍩 Request Feature · 🤔 Ask Questions
ts-toolbelt ships utility types that provide simple ways to update, change, and compute TypeScript types. It offers unique dynamic features, allowing you to write type-safe software more easily and in less time than you do today.
Its programmatic API brings new capabilities to TypeScript with +200 tested type utilities. This makes it the largest and the most reliable type collection out there. It uses the type system itself for TypeScript to compute complex types. So its API exposes types that trade CPU & RAM for higher type safety.
You'll find all the types you can ever need in this single and well organized package.
Here's some of the most useful utilities:
TIPIf you don't find the type you are looking for, you are welcome to open a feature request!
Lowest TypeScript support starts at v3.5
npm install typescript@^3.8.0 --save-dev
For best results, add this to your tsconfig.json
{
"compilerOptions": {
// highly recommended (required by few utilities)
"strictNullChecks": true,
// this is optional, but enable whenever possible
"strict": true,
// this is the lowest supported standard library
"lib": [
"es2015",
],
}
}
npm install ts-toolbelt --save
import {Object} from "ts-toolbelt"
// Check the docs below for more
// Merge two `object` together
type merge = Object.Merge<{name: string}, {age?: number}>
// {name: string, age?: number}
// Make a field of an `object` optional
type optional = Object.Optional<{id: number, name: string}, "name"}>
// {id: number, name?: string}
TIPYou can also grab the demo over here.
You can level-up, and re-code this library from scratch.
To get you started, we recommend that you visit the documentation of the following essential tools.
The documentation is complete but it needs more examples. So feel free to ask for examples.
The project is organized around TypeScript's main concepts:
| Any | Boolean | Class | Function | Iteration | List |
| Number | Object | Object.P | String | Union | Test |
TIPHow to choose categories? Match your type with them.
There are many ways to import the types into your project:
Explicit
import {Any, Boolean, Class, Function, Iteration, List, Number, Object, String, Union} from "ts-toolbelt"
Compact
import {A, B, C, F, I, L, N, O, S, U} from "ts-toolbelt"
Portable
import tb from "ts-toolbelt"
You can also import our non-official API from the community:
import {Community} from "ts-toolbelt"
TIPThe community API is for our community to publish useful types that don't see fit in the standard API.
If you're interested to learn how the internals work, this tutorial will get you on track to start writing your own types.
Access older docs at https://millsp.github.io/ts-toolbelt/version/
In this wiki, you will find some extra resources for your learning, and understanding.
Are you missing something? Participate to the open-wiki by posting your questions.
Stay up to date with the latest announcements with this regular digest of important changes.
Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated. There are many ways to contribute to the project:
Fork the project
Clone your fork
Create a pr/feature branch
git checkout -b pr/CoolFeature
Commit your changes
You must follow the conventional commit to be able to commit
git commit -m "feat(name): Added this CoolFeature"
Push your changes
npm run release -- --no-tags
Open a pull request
To run the lint & type tests, simply run:
npm test
Want to test your own types? Let's get started:
import {Number, Test} from "ts-toolbelt"
const {checks, check} = Test
checks([
check<Number.Plus<"1", "30">, "31", Test.Pass>(),
check<Number.Plus<"5", "-3">, "2", Test.Pass>(),
])
TIPPlace it in a file that won't be executed, it's just for TypeScript to test types.
The releases are done with Travis CI in stages & whenever a branch or PR is pushed:
npm testIf you wrote tests & would like your project to be tested too, please open an issue.
The project is maintained to adapt to the constant changes of TypeScript:
| ts-toolbelt | typescript |
|---|---|
| 6.x.x | ^3.7.x |
| 4.x.x | ^3.5.x |
| 2.x.x | ^3.5.x |
| 3.x.x | ^3.5.x |
| 1.x.x | ~3.5.x |
Major version numbers will upgrade whenever TypeScript had breaking changes (it happened that TS had breaking changes on minor versions). Otherwise, the release versions will naturally follow the semantic versioning.
Sponsored issues have higher priority over non-critical issues.
You can either request a new feature or a bug fix, and then fund it.
The money will be transparently split with an issue's assignees.
Automated performance tests
# performance is checked manually with
npx tsc --noEmit --extendedDiagnostics
Need to write more examples
Many, many thanks to all the contributors and:
eledoc - 🌒 A material dark theme for TypeDocutility-types - Collection of utility types, complementing TypeScript built-in mapped types and aliases
FAQs
TypeScript's largest utility library
The npm package ts-toolbelt receives a total of 1,367,469 weekly downloads. As such, ts-toolbelt popularity was classified as popular.
We found that ts-toolbelt demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
RubyGems.org has added a new "maintainer" role that allows for publishing new versions of gems. This new permission type is aimed at improving security for gem owners and the service overall.
Security News
Node.js will be enforcing stricter semver-major PR policies a month before major releases to enhance stability and ensure reliable release candidates.
Security News
Research
Socket's threat research team has detected five malicious npm packages targeting Roblox developers, deploying malware to steal credentials and personal data.